Update a Tenant

{ updateTenant }

Updates tenant to the system.

Method

/API2/access/updateTenant

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2023.00
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Input Parameters

    Name

    updateTenant

    Object Type

    TenantObject

    Description

    The folder for a tenant object.

    Output Response

    Successful Result Code

    200

    Response Type

    ModifiedItemsResult

    Description of Response Type

    Generic API response object with success or failure flag and related messages.

    Notes

    Tenants are relevant in multi-tenant deployments and must be enabled in the admin console to take effect.